CAN-LIN SBC Click Driver

API for configuring and manipulating CAN-LIN SBC Click driver. More...

Topics
	CAN-LIN SBC Registers List
	List of registers of CAN-LIN SBC Click driver.
	CAN-LIN SBC Registers Settings
	Settings for registers of CAN-LIN SBC Click driver.
	CAN-LIN SBC MikroBUS Map
	MikroBUS pin mapping of CAN-LIN SBC Click driver.

Functions
void	canlinsbc_cfg_setup (canlinsbc_cfg_t *cfg)
	CAN-LIN SBC configuration object setup function.
err_t	canlinsbc_init (canlinsbc_t *ctx, canlinsbc_cfg_t *cfg)
	CAN-LIN SBC initialization function.
err_t	canlinsbc_default_cfg (canlinsbc_t *ctx)
	CAN-LIN SBC default configuration function.
err_t	canlinsbc_write_reg (canlinsbc_t *ctx, uint8_t reg, uint8_t data_in)
	CAN LIN SBC write register function.
err_t	canlinsbc_read_reg (canlinsbc_t *ctx, uint8_t reg, uint8_t *data_out)
	CAN LIN SBC read register function.
err_t	canlinsbc_generic_write (canlinsbc_t *ctx, uint8_t *data_in, uint16_t len)
	CAN LIN SBC generic write function.
err_t	canlinsbc_generic_read (canlinsbc_t *ctx, uint8_t *data_out, uint16_t len)
	CAN LIN SBC generic read function.
void	canlinsbc_set_rst_pin (canlinsbc_t *ctx, uint8_t state)
	CAN LIN SBC set reset pin function.
void	canlinsbc_set_txd_lin_pin (canlinsbc_t *ctx, uint8_t state)
	CAN LIN SBC set TXD LIN pin function.
uint8_t	canlinsbc_get_rxd_lin_pin (canlinsbc_t *ctx)
	CAN LIN SBC get RXD LIN pin function.
void	canlinsbc_reset_device (canlinsbc_t *ctx)
	CAN LIN SBC reset device function.
err_t	canlibsbc_check_communication (canlinsbc_t *ctx)
	CAN LIN SBC check communication function.

Detailed Description

API for configuring and manipulating CAN-LIN SBC Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

canlibsbc_check_communication()

err_t canlibsbc_check_communication

(

canlinsbc_t *

ctx

)

CAN LIN SBC check communication function.

This function checks the communication with the device by reading and verifying the device ID register.

Parameters

[in]

ctx

: Click context object. See canlinsbc_t object definition for detailed explanation.

Returns

• 0 - Success (Device ID matches),
• -1 - Error (Device ID mismatch or communication failure).

Note

None.

canlinsbc_cfg_setup()

void canlinsbc_cfg_setup

(

canlinsbc_cfg_t *

cfg

)

CAN-LIN SBC configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See canlinsbc_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

canlinsbc_default_cfg()

err_t canlinsbc_default_cfg

(

canlinsbc_t *

ctx

)

CAN-LIN SBC default configuration function.

This function executes a default configuration of CAN-LIN SBC Click board.

Parameters

[in]

ctx

: Click context object. See canlinsbc_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

This function can consist any necessary configuration or setting to put device into operating mode.

canlinsbc_generic_read()

err_t canlinsbc_generic_read	(	canlinsbc_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

CAN LIN SBC generic read function.

This function reads a specified number of bytes from the CAN LIN SBC device using UART communication.

Parameters

[in]	ctx	: Click context object. See canlinsbc_t object definition for detailed explanation.
[out]	data_out	: Buffer to store the read data.
[in]	len	: Number of bytes to read.

Returns

• 0 - Success,
• -1 - Error.

Note

None.

canlinsbc_generic_write()

err_t canlinsbc_generic_write	(	canlinsbc_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

CAN LIN SBC generic write function.

This function writes a specified number of bytes to the CAN LIN SBC device using UART communication.

Parameters

[in]	ctx	: Click context object. See canlinsbc_t object definition for detailed explanation.
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to write.

Returns

• 0 - Success,
• -1 - Error.

Note

None.

canlinsbc_get_rxd_lin_pin()

uint8_t canlinsbc_get_rxd_lin_pin

(

canlinsbc_t *

ctx

)

CAN LIN SBC get RXD LIN pin function.

This function reads the logic state of the RXD LIN pin.

Parameters

[in]

ctx

: Click context object. See canlinsbc_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

canlinsbc_init()

err_t canlinsbc_init	(	canlinsbc_t *	ctx,
		canlinsbc_cfg_t *	cfg )

CAN-LIN SBC initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See canlinsbc_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See canlinsbc_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

canlinsbc_read_reg()

err_t canlinsbc_read_reg	(	canlinsbc_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out )

CAN LIN SBC read register function.

This function reads a byte of data from the specified register using the SPI interface.

Parameters

[in]	ctx	: Click context object. See canlinsbc_t object definition for detailed explanation.
[in]	reg	: Register address.
[out]	data_out	: Pointer to store the read data.

Returns

• 0 - Success,
• -1 - Error.

Note

None.

canlinsbc_reset_device()

void canlinsbc_reset_device

(

canlinsbc_t *

ctx

)

CAN LIN SBC reset device function.

This function resets the CAN LIN SBC device by toggling the RST pin.

Parameters

[in]

ctx

: Click context object. See canlinsbc_t object definition for detailed explanation.

Returns

None.

Note

None.

canlinsbc_set_rst_pin()

void canlinsbc_set_rst_pin	(	canlinsbc_t *	ctx,
		uint8_t	state )

CAN LIN SBC set reset pin function.

This function sets the logic state of the reset (RST) pin.

Parameters

[in]	ctx	: Click context object. See canlinsbc_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.

canlinsbc_set_txd_lin_pin()

void canlinsbc_set_txd_lin_pin	(	canlinsbc_t *	ctx,
		uint8_t	state )

CAN LIN SBC set TXD LIN pin function.

This function sets the logic state of the TXD LIN pin.

Parameters

[in]	ctx	: Click context object. See canlinsbc_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.

canlinsbc_write_reg()

err_t canlinsbc_write_reg	(	canlinsbc_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

CAN LIN SBC write register function.

This function writes a byte of data to the specified register using the SPI interface.

Parameters

[in]	ctx	: Click context object. See canlinsbc_t object definition for detailed explanation.
[in]	reg	: Register address.
[in]	data_in	: Data to be written to the register.

Returns

• 0 - Success,
• -1 - Error.

Note

None.